home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr48 / uudvd_04.zip / MANUAL < prev    next >
Text File  |  1995-02-04  |  10KB  |  216 lines
  1. UUdeview Manual
  2. ***************
  3.  
  4. This text mainly covers the Unix and DOS versions of UUdeview, where
  5. the decoding process is all the same. Some of the text here does also apply
  6. to the users of UUdeview for Windows. 
  7.  
  8.  While all of the below actions can be used with UUdeview for
  9.  Windows, you will usually use the Launcher application to ease the
  10.  decoding procedure. I recommend reading through the Windows
  11.  Installation and Usage manual first; and then reading the rest of the
  12.  text, skipping the sections that don't apply to you. 
  13.  
  14. I expect you to have properly installed the program by now. 
  15.  
  16. Running UUdeview
  17. ================
  18.  
  19. Once you have saved the articles into one or many files, you can start
  20. UUdeview. Get to the command line, and type 
  21.  
  22.         uudeview [options] <filename(s)>
  23.  
  24. If you had to save the articles into different files, you can also enter
  25. wildcards for the filename (as in "file*.txt").
  26. UUdeview should now scan the article file(s), show you which articles it
  27. has found, and combine different parts. In some cases, SPMS will also try
  28. to correct some of the poster's errors. At the end of this scanning process,
  29. it will report which file it has found, and then switch to command mode. You
  30. can now enter commands to decode the file, rename it or to do a couple of
  31. other more or less weird things with the file.
  32. The default command is `?`, which will inform you of your choices. See
  33. below for the other commands
  34.  
  35. UUdeview's options
  36. ==================
  37.  
  38. Each option is exactly one character. The option can be switched 'on' by
  39. preceding it with a plus sign or switched 'off' by preceding it with a minus
  40. sign. What 'on' and 'off' means is not always obvious, so look out below. 
  41.  
  42.  Note: If you use UUdeview for Windows, you can use these options
  43.  by defining them in the Launcher's Additional Options menu.
  44.  However, most of the work is automatically done from within the 
  45.  Options menu. 
  46.  
  47. +e 
  48.    Describes a set of extensions to be decoded exclusively. You must
  49.    line up the extensions, each one preceded by a dot with no space
  50.    between two extensions.
  51.    +e .jpg.JPG.gif.GIF instructs the program to ignore
  52.    postings other than jpg or gif pictures. Note that the extension
  53.    check is case sensitive. All this has to change sometimes, because
  54.    this doesn't allow double extensions (like in .tar.gz). 
  55. -e 
  56.    is the reverse of +e. Here, you can give a set of extensions that the
  57.    program should ignore, with the same limitations as above.
  58.    -e .bmp.BMP tells the program to process everything but
  59.    Windows Bitmap files.
  60.    Please note that each 'e' option cancels all previous ones. Only the
  61.    last 'e' option is used. Despite their limits, both options are quite
  62.    useful in conjunction with the following one. 
  63. -i 
  64.    Tells UUdeview do process the files without user interaction. That
  65.    is, all files are decoded to the current directory without asking
  66.    (batch decoding). With the 'e' options, you can direct the program
  67.    not to process some types of files.
  68.    +e .jpg.gif -i automagically decodes all pictures.
  69.    Similarly, '+i' will enable user interaction; but this is really not
  70.    needed because it's the default. 
  71. -r 
  72.    Instructs the program not to ignore replies. Usually, replies in
  73.    postings do not feature useful binary data, so they are ignored to
  74.    save space and time. Only in some cases it might be useful not to
  75.    ignore them, especially when decoding mail folders.
  76.    Similarly, '+r' will cause replies to be ignored; which is the default. 
  77. +u 
  78.    Given this option, UUdeview will try to uncompress or gunzip the
  79.    current file, if it has the '.z' or '.gz' extension. This feature is quite
  80.    untested so far, and after all it only works if you have uncompress
  81.    and gunzip installed.
  82.    Again, '-u' tells UUdeview not to uncompress files, which again is
  83.    the default behaviour. 
  84. +d 
  85.    Sets the desperate mode, in which the program will also process
  86.    incomplete files. Everything until the first missing part will be
  87.    decoded (if the first part is missing, nothing is decoded). The reason
  88.    is that there are no file formats (except plain text) that can recover
  89.    from missing data. '-d' is default (the program hopes that you don't
  90.    get desperate too frequently). 
  91. -p path 
  92.    Sets the decoding path, that is, the path, where decoded binaries
  93.    will be saved to. If you use the program interactively, you can also
  94.    set it from within the program.
  95.    There is no such thing as a +p option. 
  96.  
  97. UUdeview startup
  98. ================
  99.  
  100. Upon startup, the program will scann all the given files for uuencoded data.
  101. It prints out some information that was primarily included for debugging
  102. purposes, but maybe it can help you to understand what the hell it is doing.
  103. It does three steps before prompting you for anything, loading, combining
  104. and merging. 
  105.  
  106. Loading
  107. +++++++
  108.  
  109. All different postings are detected (that is, anything with a subject line). For
  110. each posting, one line with the subject and some information is printed.
  111. Here is part of an example: 
  112.  
  113. Loaded 'profavi.zip part 0/0 THE_AVI (Description)'  0
  114. Loaded 'profavi.zip, part 01/15 THE_AVI' profavi.zip begin data 1
  115. Loaded 'profavi.zip, part 02/15 THE_AVI'  data 2
  116. ...
  117. Loaded 'profavi.zip, part 15/15 THE_AVI'  end data 15
  118.  
  119. The text in quotes is the original subject line. The number after the subject
  120. is the part number which uudeview has detected. If a 'begin' line is
  121. encountered, 'begin' is printed along with the file name (here: 'profavi.zip'),
  122. if 'end' is found, it is printed as well. If a posting contains uuencoded data,
  123. the keyword 'data' is printed. In some cases, UUdeview might be unable to
  124. detect the data, and you will wonder why a certain program is not
  125. presented for decoding. You will be able to detect this case here; get
  126. suspicious if there are parts without the word 'data'. 
  127.  
  128. Combining
  129. +++++++++
  130.  
  131. Now UUdeview combines all parts of one file, that is, all the postings with
  132. the same subject line (well, subject line minus part number, of course). For
  133. each file, it reports which parts have been found. Again, it is printed if the
  134. postings have 'begin' and 'end' lines. In the case of the above posting, the
  135. program reports 
  136.  
  137. Found File 'profavi.zip' Part NOs 0 1 begin 2 ... 15 end OK
  138.  
  139. The OK at the end means that everything seems to be OK with this file and
  140. that it is ready to being decoding. 
  141.  
  142. Merging
  143. +++++++
  144.  
  145. In some cases, the SPMS system will step in, desperately trying to recover
  146. from the mistakes of the poster. Here's an example: 
  147.  
  148. Loaded 'WinG (1/2) Ok, someone wanted WinG' wing10.zip begin data 1
  149. Loaded 'WinG10.zip (2/2) First One was huge, this is TINY'  end data 2
  150. Found File 'wing10.zip' Part NOs 1 begin
  151. Found File 'WinG10.zip' Part NOs 2 end
  152.  
  153. Parts of 'WinG' merged with parts of 'WinG10.zip'. Check 1 begin 2 end OK
  154.  
  155. Here, the poster has made the mistake of posting two parts of the same file
  156. with a different subject line. Both parts are detected, but are 'combined'
  157. seperately. Now, SPMS detects that the first posting was sent as part one,
  158. which only had a beginning but no end. The other posting had part two and
  159. no beginning but an end. Therefore, it merges these separate postings into
  160. a file with two parts, which then has a beginning and an end. It then
  161. rechecks the newly created file and finds it OK. 
  162.  
  163. UUdeview commands
  164. =================
  165.  
  166. Finally, after all the startup crap is done, you will be prompted what to do
  167. with each file (if you have not disabled interactivity with the '-i' option). 
  168. The program asks you for an action, and presents '?' as the default action,
  169. which will give you a short list of all available actions. There are the
  170. following: 
  171.  
  172. (?) 
  173.    (default action) gives a short list of all available actions. 
  174. (d) 
  175.    decodes the file and writes it to disk. Files are always written to the
  176.    directory where you have started uudeview. Therefore, you should
  177.    always start up uudeview from your binaries directory (I always
  178.    change to /tmp). 
  179. (y) 
  180.    'yes', does exactly the same as (d) 
  181. (n) 
  182.    Do not decode this file and go to the next file. 
  183. (i) 
  184.    Show file Info. Prints out the zeroeth part of the file if available, or the
  185.    first part up to the beginning of encoded data. Some of the most
  186.    annoying headers are stripped. 
  187. (e) 
  188.    Run a shell command. The best part is, you can actually use the
  189.    actual file as part of the command! Simply enter a dollar sign '$'
  190.    where the filename shall appear. If you have xv installed, you can
  191.    view a picture before decoding by entering "xv $". Note that the
  192.    shell will not get the actual filename but a temporary filename. Using
  193.    programms that depend on any filename extension (rather than
  194.    some magic number) will fail.
  195.    Note: This action is not available in UUdeview for Windows. 
  196. (l) 
  197.    will list a text file. You'll get a lot of junk if you try this command on
  198.    anything other than text files. This is the same as the (e) command
  199.    with "more < $". 
  200. (r) 
  201.    prompts you for an alternate filename. If you later (d)ecode the file, it
  202.    will be written under this new filename. Any directory will be
  203.    stripped from this filename. 
  204. (p) 
  205.    allows you to change the save path, that is, the directory where
  206.    decoded binaries will be saved to. You can see the present path in
  207.    the command description (which you get with the (?) action). 
  208. (q) 
  209.    quits the program without prompting for all the other files. 
  210. (c) 
  211.    displays the copyright notice and some other blah. 
  212.  
  213.  
  214. Frank Pilhofer <fp@informatik.uni-frankfurt.de> Back to the Homepage
  215. Last modified: Wed Feb 1 14:26:45 1995 
  216.